Glitch Distributions
==========

This page contains the documentation for 'glitch_dist.py'. This module provides methods for sampling glitch parameters from given distributions. The distributions are based off of Bayesian inference done in Bondarescu et al. 2023 (arXiv 2309.06594).

Function Definitions
----------------------

.. raw:: html

   <div class="function-box">
   <strong>GlitchPop.glitch_dist.rand_params(glitch, amp_bound=None, phase_bound=None, f0_bound=None, gbw_bound=None, time_bound=None, suggest=False, seed=None, time_offset=False)</strong>
   </div>

Function to randomly generate glitch parameters based off of parametrized distributions.

**Parameters:**

- **glitch** (string) - Name of glitch to generate parameters for
- **amp_bound** (NoneType or tuple) - Optional lower and upper bounds on amplitude distribution
- **phase_bound** (NoneType or tuple) - Optional lower and upper bounds on phase distribution
- **f0_bound** (NoneType or tuple) - Optional lower and upper bounds on central frequency distribution
- **gbw_bound** (NoneType or tuple) - Optional lower and upper bounds on gamma distribution
- **time_bound** (NoneType or tuple) - Optional lower and upper bounds on central time offset distribution
- **suggest** (bool) - Optional argument to use suggested bounds
- **seed** (NoneType or int) - Optional random seed
- **time_offset** (bool) - Argument to enable generation of central time offset, otherwise, set to zero

**Returns:**

- **list** - List containing floats of glitch parameters